﻿#region License, Terms and Conditions
//
// Copyright (c) 2008, aspZone.com
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//     * Neither the name of the <organization> nor the
//       names of its contributors may be used to endorse or promote products
//       derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY aspZone.com ``AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL <copyright holder> BE LIABLE FOR ANY
// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author(s):
//  John Rudolf Lewis (http://aspZone.com)
//
#endregion

namespace AspZone.Commerce.Model
{
    using System.Collections.Generic;

    /// <summary>
    /// Representation of a product category in the store.
    /// </summary>
    public class Category
    {
        public Category()
        {
            ChildCategories = new List<Category>();
            Products = new List<Product>();
            this.Visible = true;
        }

        /// <summary>
        /// Gets or sets the primary unique identifier.
        /// </summary>
        public int Id { get; set; }

        /// <summary>
        /// Gets or sets the unique name of the Category.
        /// </summary>
        public string Name { get; set; }

        /// <summary>
        /// Gets or sets the short description of the Category.
        /// </summary>
        /// <remarks>
        /// Used as a one line very short description of the Product, such as listing of 
        /// products in the cart, category listings, etc. No Rich HTML will be allowed here.
        /// </remarks>
        public string ShortDescription { get; set; }

        /// <summary>
        /// Gets or sets the long description of the Category.
        /// </summary>
        /// <remarks>
        /// To be displayed in a category detail view. Rich HTML content allowed.
        /// </remarks>
        public string LongDescription { get; set; }

        /// <summary>
        /// Gets or sets the name of the Category for use in &lt;Title&gt; tags.
        /// </summary>
        public string SEOTitle { get; set; }

        /// <summary>
        /// Gets or sets the name of the category for use in SEO url's
        /// </summary>
        public string SEOName { get; set; }

        /// <summary>
        /// Gets or sets the keywords for the Category.
        /// </summary>
        /// <remarks>
        /// Comma delimited list of Keywords to be used in the meta tags of a view.
        /// </remarks>
        public string SEOKeywords { get; set; }

        /// <summary>
        /// Gets or sets the Id of the parent category.
        /// </summary>
        public int? ParentCategoryId { get; set; }

        /// <summary>
        /// Gets or sets the parent category.
        /// </summary>
        public Category ParentCategory { get; set; }

        /// <summary>
        /// Gets or sets the child categories.
        /// </summary>
        public IList<Category> ChildCategories { get; set; }

        /// <summary>
        /// Gets or sets the List of <see cref="Product"/> that are in this Category.
        /// </summary>
        public IList<Product> Products { get; set; }

        /// <summary>
        /// Gets or sets a value indicating whether or not the Category is visible.
        /// </summary>
        public bool Visible { get; set; }

        /// <summary>
        /// Gets or sets the sort order.
        /// </summary>
        public int SortOrder { get; set; }

        /// <summary>
        /// Gets or sets the image for the Category
        /// </summary>
        public Image Image { get; set; }

        /// <summary>
        /// Determines whether this Category and a specified Category are the same entity.
        /// </summary>
        /// <param name="category">the Category with which to compare with this one.</param>
        /// <returns>true if the two categories are the same entity.</returns>
        public bool Equals(Category category)
        {
            return category.Id == this.Id;
        }

        /// <summary>
        /// Returns a string representation of this Category,
        /// </summary>
        /// <returns>a string value that represents this Category.</returns>
        public override string ToString()
        {
            return this.Name;
        }

        /// <summary>
        /// Returns the hashcode of this instance.
        /// </summary>
        /// <returns>the hashcode of this instance</returns>
        public override int GetHashCode()
        {
            return this.Id.GetHashCode();
        }
    }
}
